////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, Konstantin Kovalev aka Constantiner (constantiner at gmail dot com)
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that 
// the following conditions are met:
// * Redistributions of source code must retain the above copyright notice, this list of conditions and 
// the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and 
// the following disclaimer in the documentation and/or other materials provided with the distribution.
// * Neither the name of the Konstantin Kovalev aka Constantiner nor the names of its contributors 
// may be used to endorse or promote products derived from this software 
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS 
// OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY 
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 
// OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, 
// OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
// OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
////////////////////////////////////////////////////////////////////////////////
package com.riapriority.planetlist.util
{
	import com.riapriority.planetlist.data.PlanetDescription;
	import com.riapriority.planetlist.renderer.PlanetRendererDimentions;
	
	import flexunit.framework.Assert;
	
	import mx.utils.StringUtil;

	/**
	 * Contains base methods to test.
	 * @author Konstantin Kovalev (constantiner at gmail dot com)
	 */
	public class PlanetCalculatorTestBase
	{
		/**
		 * Created reasonable planet description instance.
		 * @param distanceFromSunKm Is distanceFromSunKm parameter value.
		 * @param radiusKm Is radiusKm parameter value.
		 * @return Resulting description.
		 *
		 */
		protected function getPlanetDescription(distanceFromSunKm:Number, radiusKm:Number):PlanetDescription
		{
			var result:PlanetDescription = new PlanetDescription();
			result.distanceFromSunKm = distanceFromSunKm;
			result.radiusKm = radiusKm;
			return result;
		}

		/**
		 * Performs assertions for dimentions.
		 * @param message Is assertion message.
		 * @param expectedInnerRadius Is expected innerRadius parameter value.
		 * @param expectedOrbitRadius Is expected orbitRadius parameter value.
		 * @param expectedOuterRadius Is expected outerRadius parameter value.
		 * @param expectedPlanetSize Is expected planetSize parameter value.
		 * @param actual Is actual dimentions to compare to.
		 *
		 */
		protected function assertDimentionsTheSame(message:String, expectedInnerRadius:Number,
												   expectedOrbitRadius:Number, expectedOuterRadius:Number,
												   expectedPlanetSize:Number, actual:PlanetRendererDimentions):void
		{
			Assert.assertEquals(StringUtil.substitute("{0} {1}", message, "InnerRadius"),
								expectedInnerRadius, actual.innerRadius);
			Assert.assertEquals(StringUtil.substitute("{0} {1}", message, "OrbitRadius"),
								expectedOrbitRadius, actual.orbitRadius);
			Assert.assertEquals(StringUtil.substitute("{0} {1}", message, "OuterRadius"),
								expectedOuterRadius, actual.outerRadius);
			Assert.assertEquals(StringUtil.substitute("{0} {1}", message, "PlanetSize"),
								expectedPlanetSize, actual.planetSize);
		}
	}
}